-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
BLD: Add useful shortcuts to Makefile #3803
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
can u add doc: develop
-rm -rf doc/source/generated
-cd doc
-python make.py clean
-python make.py html
-cd .. or something like it? i'm always building docs now that it's like a second mini testing suite :) |
the only thing is I always have to add my path to
or is this just me being stupid? |
hm i don't get that, but i remember i used to get it on another project and do the same thing to my path, i never changed it so i'm not sure what the fix is |
@cpcloud I added the task you recommended. Suggestion for you too: you might try installing guard and then using this Guardfile that I wrote up for the pandas repo. This should, in general, automatically run tests as you change files (and I added a part so that it would automatically rebuild the docs if you make changes). That said, are you sure that you want the |
Hold on - don't merge this, made a mistake in the Makefile. |
@jtratner ur right def should remove the |
on second thought i'm not sure i like removing the extensions since they take so long to build what about just removing pyc and having another make directive that removes the extensions explicitly like |
Sure, I think that makes sense . |
I believe this all works now. |
-cd doc; \ | ||
python make.py clean; \ | ||
python make.py html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jtratner no cd ..
here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@cpcloud Makefile runs it in a separate thread, that's why all of the last 3 statements are actually on one line. (with line continuation characters and semi-colons). Try removing the "; " from the end of line 27 and you'll see that it complains about being in the wrong folder, because it executes the cd
in a separate thread.
@jtratner oh right I forgot about this feature/quirk. I haven't used make in a while. |
definitely a quirk On Sat, Jun 8, 2013 at 1:15 AM, Phillip Cloud [email protected]:
|
@jtratner just noticed that the |
wonder if there are any other mindless tasks we can delegate to the gods of |
@cpcloud we could improve I was thinking it could be improved to: test: build
-./test_fast.sh Another option could be: perf: build
-./test_perf.sh |
there's a psychological benefit to not having to wait 3.5 minutes for the full test suite to finish especially if i didn't make any changes in the things that run slow...HOWEVER of course you could have touched something in the "fast" parts that breaks something in the "slow" parts. can u have args to make directives? like |
@cpcloud it's tricky to add arguments to Makefiles. I'd be okay with adding I'm sticking to using a Guardfile with pandas, because it makes it so you don't have to think about running the tests :) |
ur right that looks outrageous |
@cpcloud so, which tasks do you want here? |
up to u but i'm partial to |
although i think u could prolly leave em out since it's less to type |
this looks good 2 me...@jreback ? |
this is ok too |
@jtratner anything else b4 i merge? |
@cpcloud do you think that build should really be silenced? (i.e., if it encounters an error it ignores it) Maybe it makes more sense to have it fail loudly. |
not sure what u mean...is that what the "-" does? |
@cpcloud Yes. so right now, if you did |
i would say always propagate errors since you don't want things to just blindly continue if something failed...:) even though errors are of course annoying better to fail fast then fail much, much later after 1000 things have gone wrong! i just thought that the "-" was |
@jtratner Sorry about that. Not a huge make user. I usually end up just writing bash functions to do my bidding... |
shall i merge? |
ok |
BLD: Add useful shortcuts to Makefile
thanks @jtratner |
@cpcloud do you want to update the wiki page with some of these types of things? (e.g. make a dev page) and add the info from the note to selves issues? (or link to it) |
This isn't totally updated so hopefully you didn't merge this yet :)
|
whoops didn't realize. can u submit another pr with the changes. sorry i thought u were finished |
@jreback i like the wiki but i feel like it won't ever get used. if we are going to use it i think contributing.md should live there as well as a link to #3156 plus 2-3 git workflows i will write these...that way i can close the issue on the website repo + consolidate these things. the previous link on the website should then link to the wiki. sound ok? |
I think contributing is fine to move to wiki, e.g. maybe make a contributing type page, and advanced pages or something.....let's start and see how it goes....sort of like an easy refernce page ideally could have people actually contribute to it (e.g. recipes)....but let's start small |
i think it still has to be in the top level so that peopl will get that message on gh when they are opening an issue |
What if we had a github pages branch instead? It would be on a separate
|
And I'd volunteer to set it up if that's helpful What if we had a github pages branch instead? It would be on a separate i think it still has to be in the top level so that peopl will get that — |
go 4 it.... |
Not sure I can, I think you have to have commiter access to setup. I can
|
ok...i'll create a couple of pages....'Contributing'? 'Developers'? to start off (can always rename later) |
sounds good to me. |
Ditto
|
Would you want to move over the developing page from the docs? (or at least
|
real basic: https://github.com/pydata/pandas/wiki copy for now (so its inline); have to link the dev page docs to this and main docs too |
@jreback Sorry, this isn't quite what I mean. I mean you should look at this - https://help.github.com/articles/user-organization-and-project-pages I can definitely create wiki pages. The upside of a github page is that it adds a new branch |
I see what u mean but I think u can push/ pull wiki pages too I like that its right off of the github main menu hg-pages sounds similar to docs, right ? |
@jreback yes, I can definitely edit wiki pages. It sounded like you wanted people to be notified when there were changes to the dev docs/wiki. Do you get notified on wiki changes? |
i haven't ever gotten any notifications about it |
what do u mean fewer notifications is good!?!? :P |
lol, I have no preference either way - easier to make sure that everything is right when using gh-pages, but less need to merge branches with wiki. :P |
i think maybe the wiki for now...gh-pages seems very similar to docs, plus i can just go and edit the wiki anytime i want to write something rather than opening vim, writing, committing, pushing etc. |
sounds good...can I push new updates to this or do I need to make a new PR? |
should make a new pr. u can use the same branch tho |
Add some shortcuts to make it easier to develop with pandas.
now there's a set of commands in the
Makefile
in the top-level pandas directory with the following functionalitymake clean
will delete thebuild
anddist
directories + all*.pyc
and*.so
filesmake clean_pyc
just removes*.pyc
filesmake build
will build extensions inplacemake develop
will installpandas
in your environment but will place a link to the dev dir so that you can make changes and they will show up immediatelymake doc
will build the documentation from scratch (erases generated and build directories)